home *** CD-ROM | disk | FTP | other *** search
/ Merciful 5 / Merciful - Disc 5.iso / software / h / hypertextdatav40.12cr.lha / HTDS / Docs / hypertext.hguide < prev    next >
Encoding:
Amiga HyperGuide  |  1997-03-31  |  23.2 KB  |  703 lines

  1. @hyperguide HyperText.hguide
  2. @$VER: HyperText.hguide 40.14 (30.03.97)
  3. @macro m_prg "@{b}HyperText DataType@{ub}"
  4. @macro m_template "Template : $1@{line}@{line}"
  5. @macro m_sscr "@{smallfont}$1@{deffont}"
  6. @include htds.hgm
  7.  
  8. @node main "HyperText Dataype Documentation"
  9. @toc HTDS.hguide/main
  10. @prev HTDS.hguide/main
  11. @next hyperguide.hguide/main
  12.  
  13. @{jcenter}@{m_title}@{m_copyright}@{m_welcome}@{jleft}
  14.  
  15. @{settabs 30}
  16. @{m_sec Menu}
  17. @{m_menuitem}@{" Configuration " link     Configuration  }@{m_menuinfo "Adaption to your system"}
  18. @{m_menuitem}@{" Node indexing " link     NodeIndexing   }@{m_menuinfo "speeds up document opening"}
  19. @{m_menuitem}@{" Color expressions " link ColorExpressions}@{m_menuinfo "how to define new colors"}
  20. @{m_menuitem}@{" User Interface " link    UserIFace      }@{m_menuinfo "buttons, key-bindings and requesters"}
  21. @{m_menuitem}@{" ARexx Interface " link   ARexxIFace     }@{m_menuinfo "known ARexx commands"}
  22. @{m_menuitem}@{" Common Attributes " link CommonAttrs    }@{m_menuinfo "HyperGuide Attributes"}
  23. @{m_menuitem}@{" XRef Interface " link    XRefIFace      }@{m_menuinfo "Cross-Reference Interface"}
  24. @{m_menuitem}@{" Dynamic Nodes " link     DynamicNodes   }@{m_menuinfo "Dynamic Nodes Interface"}
  25. @{m_menuitem}@{" Sub Datatypes " link     HTDS.hguide/SubDataTypes}@{m_menuinfo "available sub datatypes"}
  26.  
  27. @{m_menuitem}@{" Copyright " link         HTDS.hguide/Copyright   }@{m_menuinfo "legal stuff"}
  28. @{m_menuitem}@{" Author " link            SR.hguide/Addresses     }@{m_menuinfo "how to contact ..."}
  29. @{m_menuitem}@{" Registration " link      HTDS.hguide/Registration}@{m_menuinfo "It's Shareware !!!"}
  30. @{m_endsec}
  31.  
  32. @endnode
  33. @node Configuration "HyperText/Configuration"
  34.  
  35. @{m_sec Configuration}
  36. As the recommended standard for datatypes, the preference file for the
  37. hypertext.datatype is called @{m_file hypertext.prefs} and is searched first in
  38. the @{m_file PROGDIR:Prefs/DataTypes} and then in @{m_file Env:DataTypes} directory.
  39. The following options are currently available using @{"ReadArgs()" link "dos/ReadArgs()"}
  40. argument parsing with the following templates. Each template is introduced with a
  41. prefix. This prefix has to be the very first in a line :
  42.  
  43. @{itemize}
  44. @{item}@{m_cfgpre PATH}PATH/M/A
  45. @{definition}
  46. @{defterm}PATH
  47. @{defdata}Specifies the directories, which should be used for searching for any
  48. documents or embedded objects. Same as AmigaGuide PATH environment
  49. variable.
  50. @{enddefinition}
  51. @{item}@{m_cfgpre KEYFILE}KEYFILE/A
  52. @{definition}
  53. @{defterm}KEYFILE
  54. @{defdata}Specifies the full path of the HTDS keyfile. This keyfile is needed
  55. to use HTDS without restrictions. See @{" Registration " Link HTDS.hguide/Registration}.
  56. @{enddefinition}
  57. @{item}@{m_cfgpre GLOBAL}SHOWLINK/S,GLOBALTOC/S,ENDLESSTABCYCLE/S,SECURE/S,REXXSUFFIX/K,
  58. LISTINDENT/N/K,NODEINDEXING/S
  59. @{definition}
  60. @{defterm}SHOWLINK
  61. @{defdata}If this option is set, the link address will be shown in the window title,
  62. if the user press down the link button. So the user can check, where the link
  63. point to it, before following the link.@{line}
  64. This feature is implemented for the upcoming html.datatype subclass. I know
  65. that almost all Web-Browser show the linked address just by moving the mouse
  66. over the link. But this behaviour can't be implemented due to the fact BOOPSI
  67. handle input events. Any BOOPSI gadget must be active to get input events, but
  68. activation of a BOOPSI gadget is subject of the application, which uses the
  69. BOOPSI gadget (MultiView).
  70.  
  71. @{defterm}GLOBALTOC
  72. @{defdata}If this option is set then any HyperText object, which hasn't a Table
  73. of Contents entry, the contents button is set to the @{m_file HTDS_TOC.hguide}
  74. document in the directory @{m_file "Help:<language>"}.@{line}
  75. You can use the provided ARexx script @{m_sample AddTOCEntry.rexx} to add the
  76. object currently displayed in MultiView to this global table of contents.
  77.  
  78. @{defterm}ENDLESSTABCYCLE
  79. @{defdata}If this option is set, tabcycle is endless. That means, if the last
  80. link is active and you cycle forward, the first link is activated and vice
  81. versa.
  82.  
  83. @{defterm}SECURE
  84. @{defdata}If this option is set, you cannot start any program or ARexx script
  85. from a link.
  86.  
  87. @{defterm}REXXSUFFIX
  88. @{defdata}This option is for compatibility with AmigaGuide. The amigaguide.datatype
  89. uses a suffix of @{m_sample guide}, where the @{hyperguide} uses normal
  90. @{m_sample rexx} suffix. So if you want AmigaGuide compatibility set this
  91. option to @{m_sample guide}.
  92.  
  93. @{defterm}LISTINDENT
  94. @{defdata}Specifies the default number aof spaces to indent any list related
  95. indention.
  96.  
  97. @{defterm}NODEINDEXING
  98. @{defdata}Enables @{"node indexing" link NodeIndexing} for subdatatypes, which
  99. supports multiple nodes within one document/file. Currently only the @{hyperguide}
  100. datatype supports this.
  101. @{enddefinition}
  102. @{item}@{m_cfgpre BACKGROUND}DISABLEBGPIC/S,DEFBGPIC/K,DEFBGPEN/N/K,DEFFGPEN/N/K,DEFALTFGPEN/N/K,
  103. DEFBGCOLOR/K,DEFFGCOLOR/K,DEFALTFGCOLOR/K
  104. @{definition}
  105. @{defterm}DISBALEPIC
  106. @{defdata}disables any background picture. If you don't want background picture
  107. even for documents you haven't the control turn this option on.
  108.  
  109. @{defterm}DEFBGPIC
  110. @{defdata}specifies a default background picture for all hypertext objects.
  111.  
  112. @{defterm}DEFBGPEN
  113. @{defdata}specifies a default background pen for all hypertext objects.
  114.  
  115. @{defterm}DEFFGPEN
  116. @{defdata}specifies a default foreground (text) pen for all hypertext objects.
  117.  
  118. @{defterm}DEFALTFGPEN
  119. @{defdata}specifies a default alternate foreground (text) pen for all hypertext
  120. objects. This pen is used for foreground, if the foreground pen equals to the
  121. background pen.
  122.  
  123. @{defterm}DEFBGCOLOR
  124. @{defdata}same as @{m_sample DEFBGPEN} except you can specify a @{"color expression" link ColorExpressions}.
  125.  
  126. @{defterm}DEFFGCOLOR
  127. @{defdata}same as @{m_sample DEFFGPEN} except you can specify a @{"color expression" link ColorExpressions}.
  128.  
  129. @{defterm}DEFALTFGCOLOR
  130. @{defdata}same as @{m_sample DEFALTFGPEN} except you can specify a @{"color expression" link ColorExpressions}.
  131. @{enddefinition}
  132. @{enditemize}
  133. @{m_endsec}
  134.  
  135. @{m_sec "See Also"}
  136. @{" Node Indexing " link NodeIndexing}, @{" Color Expressions " link ColorExpressions}
  137. @{m_endsec}
  138. @endnode
  139. @node NodeIndexing "HyperText/Node Indexing"
  140.  
  141. @{m_sec "Node Indexing"}
  142. The node indexing facility is used to create a list of internal nodes within
  143. a document (file) without scanning the hole document. Thus the opening of a
  144. document speeds up significant.
  145.  
  146.  
  147. If a document is open the first time, the datatype scans the hole document
  148. and creates a list of internal nodes. With node indexing turned on, the
  149. datatype saves all needed information in the tooltype field of the appropriate
  150. icon. So if the document is opened a second time it tries to load the node
  151. information from the icon.
  152.  
  153.  
  154. But the information isn't correct if the document meanwhile changed. In this
  155. situation the HyperText datatype checks the date stamps for the icon and the
  156. real document and if the document is newer it scans the document as it is
  157. opened the first time. So node indexing is absolutly transparent for document
  158. writers, if you have a working realtime clock.
  159.  
  160.  
  161. For example the gcc.guide (about 1.2 MB large) took about 9 secs for opening
  162. without node indexing on my system. With node indexing it tooks under 1 sec.
  163. @{m_endsec}
  164.  
  165. @{m_sec "See Also"}
  166. @{" Configuration " link Configuration}
  167. @{m_endsec}
  168. @endnode
  169. @node ColorExpressions "HyperText/Color expressions"
  170.  
  171. @{m_sec "Color expressions"}
  172. The hypertext.datatype provides a interface to obtain a specific color.
  173. The color can be a predefined color name or a RGB value string.
  174. The RGB value string is specified in the HTML form : @{m_sample "#RRGGBB"}, where
  175. @{m_sample RR} is the red , @{m_sample GG} is the green and @{m_sample BB} is the
  176. blue portion of the RGB value specified in hexdecimal digits. For example the
  177. @{m_sample "#FF0000"} and @{m_sample "Red"} color expressions gets the same color :
  178. Red.
  179.  
  180.  
  181. Here is the table of all predefined color names :
  182.  
  183. @{settabs 20}@{code}
  184. @{fg highlight}Name@{tab}Color@{fg text}
  185.  
  186.  
  187. Black  @{tab}#000000
  188. Green  @{tab}#008000
  189. Silver @{tab}#C0C0C0
  190. Lime   @{tab}#00FF00
  191. Gray   @{tab}#808080
  192. Olive  @{tab}#808000
  193. White  @{tab}#FFFFFF
  194. Yellow @{tab}#FFFF00
  195. Maroon @{tab}#800000
  196. Navy   @{tab}#000080
  197. Red    @{tab}#FF0000
  198. Blue   @{tab}#0000FF
  199. Purple @{tab}#800080
  200. Teal   @{tab}#008080
  201. Fuchsia@{tab}#FF00FF
  202. Aqua   @{tab}#00FFFF
  203. @{cleartabs}@{body}
  204. @{m_endsec}
  205. @endnode
  206.  
  207. @node UserIFace "HyperText/User Interface"
  208.  
  209. @{m_sec "User Interface"}
  210. The User Interface splits into three parts :
  211.  
  212. @{m_sub "Buttons"}@{line}
  213. @{" Navigator Buttons " link UserIFace_Navigator}
  214.  
  215. @{m_sub "Key-bindings"}@{line}
  216. Key-bindings can be used with a new DataType method. The application you use to
  217. browse must understand this new method.@{line}
  218. @{m_bold "Note:"} This is currently under construction.
  219.  
  220. @{m_sub "Requesters"}@{line}
  221. There should be one or more requesters to interact with the HyperText object.
  222. Currently there is only one :
  223. @{itemize}
  224. @{item} @{" About Requester " link UserIFace_AboutRequester}
  225. @{item} @{" Search Requester " link UserIFace_SearchRequester}
  226. @{enditemize}
  227. @{m_endsec}
  228. @endnode
  229. @node UserIFace_Navigator "HyperText/User Interface/Navigator Buttons"
  230.  
  231. @{m_sec "Navigator Buttons"}
  232. The following buttons are available :
  233. @{definition}
  234. @{defterm}Contents
  235. @{defdata}Is used to go to the table of contents node of the actual node.
  236.  
  237. @{defterm}Index
  238. @{defdata}Is used to go to the index node of the actual node.
  239.  
  240. @{defterm}Help
  241. @{defdata}Is used to go to the help node of the actual node.
  242.  
  243. @{defterm}Retrace
  244. @{defdata}Is used to go downwards in the history list.
  245.  
  246. @{defterm}Forward
  247. @{defdata}Is used to go upwards in the history list.
  248.  
  249. @{defterm}Browse <
  250. @{defdata}Is used to go to the logical previous node of the actual node.
  251.  
  252. @{defterm}Browse >
  253. @{defdata}Is used to go to the logical next node of the actual node.
  254.  
  255. @{defterm}@{"Search"link UserIFace_SearchRequester} @{m_regonly}
  256. @{defdata}
  257.  
  258. @{defterm}@{"About" link UserIFace_AboutRequester}
  259. @{defdata}
  260. @{m_endsec}
  261.  
  262. @{m_sec "Configuration"}
  263. From version 40.7 the navigator buttons are configureable. You can define
  264. your own favorite button row. This is done by creating a ASCII file and
  265. write a line for each button. Lines beginning with a semicolon are skipped.
  266. The line is parsed using the following ReadArgs() template : "TEXT/A,COMMAND/A/F".
  267. The TEXT argument specifies the text which should displayed. The COMMAND argument
  268. specifies an @{"ARexx command" link ARexxIFace} of the hypertext.datatype.
  269.  
  270.  
  271. For each hypertext object the hypertext.datatype tries to open such a file in
  272. the specified order :
  273.  
  274. @{enumerate}
  275. @{item}PROGDIR:Prefs/DataTypes/HyperText/<datatypename>.Buttons
  276. @{item}PROGDIR:Prefs/DataTypes/HyperText/Default.Buttons
  277. @{item}Env:DataTypes/HyperText/<datatypename>.Buttons
  278. @{item}Env:DataTypes/HyperText/Default.Buttons
  279. @{endenumerate}
  280.  
  281. @{m_sub "Example"}
  282. @{separator}@{code};
  283. ; this file defines a contents and AddTOCEntry button
  284. ;
  285. Contents                   @{"CONTENTS" link ARexxIFace_CONTENTS}
  286. Add2TOC                    @{"RX" link ARexxIFace_RX} HTDS:ARexx/AddTOCEntry.rexx
  287. @{separator}@{body}
  288.  
  289. This navigator button configuration scheme is only available in the registered version.
  290. @{m_endsec}
  291. @endnode
  292. @node UserIFace_AboutRequester "HyperText/User Interface/About Requester"
  293.  
  294. @{m_sec "About Requester"}
  295. The About Requester display version and copyright information about the HTDS.
  296. @{line}@{line}@{separator}@{line}
  297. It displays also the following information about the current viewed document (object) :
  298. @{itemize}
  299. @{item} Name
  300. @{item} Version
  301. @{item} Author
  302. @{item} Copyright
  303. @{item} Annotation
  304. @{enditemize}
  305.  
  306. @{m_bold "Note"}@{line}
  307. If you want to support this feature with your own datatype. Just set the DTA_Obj#?
  308. attributes.
  309. @{m_endsec}
  310. @endnode
  311. @node UserIFace_SearchRequester "HyperText/User Interface/Search Requester"
  312.  
  313. @{m_sec "Search Requester"}
  314. The following search requester enables you to search strings and patterns
  315. in a hypertext document. The search is only line orientated. This means it matches
  316. a string exactly one time per line regardless of the number the string occured in
  317. the line :
  318.  
  319. @{line}@{line}@{jcenter}@{object /pics/SearchWin.png}@{jleft}@{line}@{line}
  320.  
  321. As you can see there are 4 checkbox gadgets, one string gadget and 2 button gadgets :
  322.  
  323. @{definition}
  324. @{defterm}`Pattern' checkbox :
  325. @{defdata}If checked the string is interpreted as a pattern
  326.  
  327. @{defterm}`Ignore Case' checkbox :
  328. @{defdata}If checked the search is case insensitve
  329.  
  330. @{defterm}`Backward search' checkbox :
  331. @{defdata}Currently not implemented and therefore disabled. But if this is checked
  332. the search will be backward.
  333.  
  334. @{defterm}`Search all nodes' checkbox :
  335. @{defdata}Currently not implemented and therefore disabled. But if this is checked
  336. the search will be done in all nodes of the current document. For example
  337. this should search all 'physical' nodes in a @{hyperguide} document and
  338. create a dynamic hypertext page, which consist out of links to all
  339. search results.
  340.  
  341. @{defterm}`String' gadget :
  342. @{defdata}Here you can type your string or pattern. If you hit return it will invoke
  343. the search routine. So just by hitting return you can step through the next
  344. occurance of your string or pattern.
  345.  
  346. @{defterm}`Search' button :
  347. @{defdata}Invokes the search routine and quits the search requester.
  348.  
  349. @{defterm}`Cancel' button :
  350. @{defdata}cancels the search requester.
  351. @{enddefinition}
  352.  
  353. The shortcuts for each gadget is reached from the string gadget by pressing left amiga
  354. key and the appropriate shortcut letter.
  355. @{m_endsec}
  356. @endnode
  357.  
  358. @node ARexxIFace "HyperText/ARexx Interface"
  359.  
  360. @{m_sec "ARexx Interface"}
  361. The @{m_prg} provides a own ARexx port for each hypertext.datatype object.
  362. It's name is the port name passed via DTA_ARexxPortName plus a
  363. suffix of '.1' or if this port exists '.2' and so on.
  364. For example if you start MultiView with a hypertext object, MultiView
  365. passes "MULTIVIEW.1" for DTA_ARexxPortName to the hypertext object.
  366. The hypertext object tries to open a port named "MULTIVIEW.1.1".
  367.  
  368.  
  369.  
  370. The following ARexx Commands are available :
  371.  
  372.  
  373. @{settabs 20 40 60 80 100 120}
  374. @{" ABOUT "    link ARexxIFace_ABOUT}@{tab}
  375. @{" BACK "     link ARexxIFace_RETRACE}@{tab}
  376. @{" BEEP "     link ARexxIFace_BEEP}@{tab}
  377. @{" CLOSE "    link ARexxIFace_CLOSE}@{tab}
  378. @{" CONTENTS " link ARexxIFace_CONTENTS}@{tab}
  379. @{" EXPORT "   link ARexxIFace_EXPORT} *@{tab}
  380. @{" FLUSH "    link ARexxIFace_FLUSH}@{tab}
  381. @{" FORWARD "  link ARexxIFace_FORWARD}@{tab}
  382. @{" GETATTR "  link ARexxIFace_GETATTR}@{tab}
  383. @{" SETATTR "  link ARexxIFace_SETATTR}@{tab}
  384. @{" HELP "     link ARexxIFace_HELP}@{tab}
  385. @{" INDEX "    link ARexxIFace_INDEX}@{tab}
  386. @{" LINK "     link ARexxIFace_LINK}@{tab}
  387. @{" NEXT "     link ARexxIFace_NEXT}@{tab}
  388. @{" NEXTINTERNAL " link ARexxIFace_NEXTINTERNAL}@{tab}
  389. @{" PREVIOUS " link ARexxIFace_PREVIOUS}@{tab}
  390. @{" QUIT "     link ARexxIFace_CLOSE}@{tab}
  391. @{" RETRACE "  link ARexxIFace_RETRACE}@{tab}
  392. @{" RX "       link ARexxIFace_RX} *@{tab}
  393. @{" SEARCH "   link ARexxIFace_SEARCH} *@{tab}
  394. @{cleartabs}
  395.  
  396.  
  397. Note: '*' marked commands are only available in the registered version.
  398. @{m_endsec}
  399.  
  400. @endnode
  401. @node ARexxIFace_ABOUT "HyperText/ARexx Interface/ABOUT"
  402.  
  403. @{m_sec ABOUT}
  404. @{m_template "none"}
  405. The ABOUT command opens the @{"about" link UserIFace_AboutRequester} requester.
  406. @{m_endsec}
  407. @endnode
  408. @node ARexxIFace_BEEP "HyperText/ARexx Interface/BEEP"
  409.  
  410. @{m_sec BEEP}
  411. @{m_template "none"}
  412. The BEEP command performs a intuition DisplayBeep().
  413. @{m_endsec}
  414. @endnode
  415. @node ARexxIFace_CLOSE "HyperText/ARexx Interface/CLOSE, QUIT"
  416.  
  417. @{m_sec "CLOSE, QUIT"}
  418. @{m_template "none"}
  419. These commands tries to quit the application of the datatype by sending
  420. it a `break c' signal.
  421. @{m_endsec}
  422. @endnode
  423. @node ARexxIFace_RETRACE "HyperText/ARexx Interface/RETRACE, BACK"
  424.  
  425. @{m_sec "RETRACE, BACK"}
  426. @{m_template "none"}
  427. These commands are used to go back to the last view'd node.
  428. @{m_endsec}
  429. @endnode
  430. @node ARexxIFace_FORWARD "HyperText/ARexx Interface/FORWARD"
  431.  
  432. @{m_sec "FORWARD"}
  433. @{m_template "none"}
  434. The command is used to go to the next viewed node of the actual node.
  435. @{m_endsec}
  436. @endnode
  437. @node ARexxIFace_GETATTR "HyperText/ARexx Interface/GETATTR"
  438.  
  439. @{m_sec "GETATTR"}
  440. @{m_template "OBJECT/A,NAME,FIELD,STEM/K,VAR/K"}
  441. This command is used to retrieve information from the HyperText-DataType-System
  442. or HyperText object. The following object types are available :
  443.  
  444. @{itemize}
  445. @{item}OBJECT@{line}
  446. Obtain information from the HyperText object. Currently the following fields
  447. are available :
  448. @{definition}
  449. @{defterm}TITLE
  450. @{defdata}objects current title.
  451.  
  452. @{defterm}PATH
  453. @{defdata}objects current full file path including node name
  454.  
  455. @{defterm}NODENAME
  456. @{defdata}objects current node name if any
  457.  
  458. @{defterm}AUTHOR
  459. @{defdata}object's author
  460.  
  461. @{defterm}COPYRIGHT
  462. @{defdata}object's copyright notice
  463.  
  464. @{defterm}ANNOTATION
  465. @{defdata}object's annotation
  466.  
  467. @{defterm}VERSION
  468. @{defdata}object's version
  469.  
  470. @{defterm}TOPVERT
  471. @{defdata}object's vertical top value (DTA_TopVert)
  472.  
  473. @{defterm}TOPHORIZ
  474. @{defdata}object's horizontal top value (DTA_TopHoriz)
  475.  
  476. @{defterm}TOTALVERT
  477. @{defdata}object's total vertical value (DTA_TotalVert)
  478.  
  479. @{defterm}TOTALHORIZ
  480. @{defdata}object's total horizontal value (DTA_TotalHoriz)
  481.  
  482. @{defterm}VISIBLEVERT
  483. @{defdata}object's visible vertical value (DTA_VisibleVert)
  484.  
  485. @{defterm}VISIBLEHORIZ
  486. @{defdata}object's visible horizontal value (DTA_VisibleHoriz)
  487.  
  488. @{defterm}VERTUNIT
  489. @{defdata}object's vertical unit value (DTA_VertUnit)
  490.  
  491. @{defterm}HORIZUNIT
  492. @{defdata}object's horizontal value (DTA_HorizValue)
  493.  
  494. @{defterm}BUFFER @{m_sscr *}
  495. @{defdata}object's raw buffer, containing raw HTML or @{hyperguide} code.
  496.  
  497. @{defterm}STATUS @{m_sscr *}
  498. @{defdata}current status of the object (OK or LAYOUT)
  499.  
  500. @{enddefinition}
  501. @{item}APPLICATION@{line}
  502. Obtain information from the HyperText environment. Currently the following fields
  503. are available :
  504. @{definition}
  505. @{defterm}VERSION @{m_sscr *}
  506. @{defdata}version of the HyperText-Datatype-System
  507.  
  508. @{defterm}SCREEN @{m_sscr *}
  509. @{defdata}public screen name the current object resides in
  510. @{enddefinition}
  511. @{fg high}@{m_sscr *}@{fg text} These fields aren't available in the STEM array.
  512. @{enditemize}
  513. @{m_endsec}
  514.  
  515. @{m_sec "Example"}
  516. @{separator}@{code}
  517. 'GETATTR OBJECT=APPLICATION FIELD=SCREEN VAR=SCREEN'
  518. 'GETATTR OBJECT=OBJECT STEM=HTDS'
  519.  
  520.  
  521. Say 'PubScreen : ' || screen
  522. Say 'ObjAuthor : ' || htds.object.author
  523. Say 'ObjVersion: ' || htds.object.version
  524. @{separator}@{body}
  525. @{m_endsec}
  526.  
  527. @{m_sec "See Also"}
  528. @{" SETATTR " link ARexxIFace_SETATTR}, Amiga User Interface Style Guide - ARexx chapter
  529. @{m_endsec}
  530. @endnode
  531. @node ARexxIFace_SETATTR "HyperText/ARexx Interface/SETATTR"
  532.  
  533. @{m_sec "SETATTR"}
  534. @{m_template "OBJECT/A,NAME,FIELD,STEM/K,VAR/K"}
  535. This command is used to set attributes of a HyperText object. The following object
  536. types are available :
  537.  
  538. @{itemize}
  539. @{item}OBJECT@{line}
  540. Set attributes of a HyperText object. Currently the following fields
  541. are available :
  542. @{definition}
  543. @{defterm}TITLE
  544. @{defdata}object's current title.
  545.  
  546. @{defterm}TOPVERT
  547. @{defdata}object's vertical top value (DTA_TopVert)
  548.  
  549. @{defterm}TOPHORIZ
  550. @{defdata}object's horizontal top value (DTA_TopHoriz)
  551. @{enddefinition}
  552. @{fg high}@{m_sscr *}@{fg text} These fields aren't available in the STEM array.
  553. @{enditemize}
  554. @{m_endsec}
  555.  
  556. @{m_sec "Example"}
  557. @{separator}@{code}
  558. title = 'My objects title'
  559. 'SETATTR OBJECT=OBJECT FIELD=TITLE VAR=TITLE'
  560. @{separator}@{body}
  561. @{m_endsec}
  562.  
  563. @{m_sec "See Also"}
  564. @{" GETATTR " link ARexxIFace_GETATTR}, Amiga User Interface Style Guide - ARexx chapter
  565. @{m_endsec}
  566. @endnode
  567. @node ARexxIFace_PREVIOUS "HyperText/ARexx Interface/PREVIOUS"
  568.  
  569. @{m_sec "PREVIOUS"}
  570. @{m_template "none"}
  571. The command is used to go to the previous node in the document. Same
  572. as "Browse <" button.
  573. @{m_endsec}
  574. @endnode
  575. @node ARexxIFace_NEXT "HyperText/ARexx Interface/NEXT"
  576.  
  577. @{m_sec "NEXT"}
  578. @{m_template "none"}
  579. The command is used to go to the next node in the document. Same
  580. as "Browse >" button.
  581. @{m_endsec}
  582. @endnode
  583. @node ARexxIFace_LINK "HyperText/ARexx Interface/LINK"
  584.  
  585. @{m_sec "LINK"}
  586. @{m_template "OBJECT"}
  587. The command is used to go to the document named with the OBJECT argument.
  588. @{m_endsec}
  589. @endnode
  590. @node ARexxIFace_HELP "HyperText/ARexx Interface/HELP"
  591.  
  592. @{m_sec "HELP"}
  593. @{m_template "none"}
  594. The command is used to go to the help document of the actual node. Same
  595. as "Help" button.
  596. @{m_endsec}
  597. @endnode
  598. @node ARexxIFace_INDEX "HyperText/ARexx Interface/INDEX"
  599.  
  600. @{m_sec "INDEX"}
  601. @{m_template "none"}
  602. The command is used to go to the index document of the actual node. Same
  603. as "Index" button.
  604. @{m_endsec}
  605. @endnode
  606. @node ARexxIFace_CONTENTS "HyperText/ARexx Interface/CONTENTS"
  607.  
  608. @{m_sec "CONTENTS"}
  609. @{m_template "none"}
  610. The command is used to go to the contents document of the actual node. Same
  611. as "Contents" button.
  612. @{m_endsec}
  613. @endnode
  614. @node ARexxIFace_SEARCH "HyperText/ARexx Interface/SEARCH"
  615.  
  616. @{m_sec "SEARCH"}
  617. @{m_template "STRING/K,PATTERN/S,NOCASE/S,PROMPT/S"}
  618. The command is used to search for a given string or pattern within the current
  619. node.
  620. With the STRING argument you can specify the string or pattern to search for.
  621. The PATTERN switch enables AmigaOS pattern search. NOCASE makes the search
  622. case insensitive. The PROMPT switch is used to open the @{"search requester" link UserIFace_SearchRequester}.
  623. @{m_endsec}
  624.  
  625. @{m_sec "NOTE"}
  626. This command is only available in the registered version.
  627. @{m_endsec}
  628. @endnode
  629. @node ARexxIFace_FLUSH "HyperText/ARexx Interface/FLUSH"
  630.  
  631. @{m_sec "FLUSH"}
  632. @{m_template "DOCUMENT/K"}
  633. This command is used to flush a document from the hypertext document cache.
  634. Its sometimes neccessary to do that, because any opened document is locked
  635. by the datatypes.library.
  636. @{m_endsec}
  637. @endnode
  638. @node ARexxIFace_RX "HyperText/ARexx Interface/RX"
  639.  
  640. @{m_sec "RX"}
  641. @{m_template "COMMAND/F"}
  642. The command is used to start a ARexx script. The COMMAND argument specifies the script.
  643. @{m_endsec}
  644.  
  645. @{m_sec "NOTE"}
  646. This command is only available in the registered version.
  647. @{m_endsec}
  648. @endnode
  649. @node ARexxIFace_EXPORT "HyperText/ARexx Interface/EXPORT"
  650.  
  651. @{m_sec EXPORT}
  652. @{m_template "FILE,CLIP/S,CLIPUNIT/N/K,TYPE/K,ARGS/F"}
  653. The EXPORT command is used to export the contents of the current node
  654. into a file or the clipboard. The TYPE argument may specify which format
  655. should be used. The appropriate export class has to exist in the
  656. @{m_file "Sys:Classes/HyperText/Export"} directory.
  657.  
  658.  
  659. @{m_sec "NOTE"}
  660. This command is only available in the registered version.
  661. @{m_endsec}
  662. @endnode
  663. @node ARexxIFace_NEXTINTERNAL "HyperText/ARexx Interface/NEXTINTERNAL"
  664.  
  665. @{m_sec NEXTINTERNAL}
  666. @{m_template "none"}
  667. This command is used to go to the next internal (physical) node within a
  668. document. So you can step through the nodes of an @{hyperguide} document
  669. in the order they appeared in the file.
  670. @{m_endsec}
  671. @endnode
  672.  
  673. @node CommonAttrs "HyperText/HyperGuide Attributes"
  674.  
  675. @{m_sec "HyperGuide Attributes"}
  676. The hypertext.datatype provides some functions to parse basic @{hyperguide}
  677. attributes such like text style and color attributes.
  678. The idea behind that is, that any subdatatype of the hypertext.datatype
  679. can use these attributes. The @{"directory.datatype" link directory.hguide/main} and the @{"man.datatype" link man.hguide/main}
  680. are examples for that. The following attributes can be used for these datatypes:
  681.  
  682. @{itemize}
  683. @{item}@{" Text Style " link hyperguide.hguide/ATTRS_TEXTSTYLE}
  684. @{item}@{" Text Font " link hyperguide.hguide/ATTRS_TEXTFONT}
  685. @{item}@{" Text Color " link hyperguide.hguide/ATTRS_TEXTCOLOR}
  686. @{item}@{" Justification " link hyperguide.hguide/ATTRS_JUSTIFICATION}
  687. @{enditemize}
  688. @{m_endsec}
  689. @endnode
  690. @node XRefIFace "HyperText/XRef Interface"
  691.  
  692. @{m_sec "Cross-Reference Interface"}
  693. @{m_niy}
  694. @{m_endsec}
  695. @endnode
  696. @node DynamicNodes "HyperText/Dynamic Nodes"
  697.  
  698. @{m_sec "Dynamic Nodes"}
  699. @{m_niy}
  700. @{m_endsec}
  701. @endnode
  702.  
  703.